home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xm / XmeStandardConvert.z / XmeStandardConvert
Encoding:
Text File  |  2001-04-17  |  16.3 KB  |  199 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt - A toolkit function that converts
  10.           selections to standard targets
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/TransferP.h>
  14.           vvvvooooiiiidddd XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt(
  15.           WWWWiiiiddddggggeeeetttt wwwwiiiiddddggggeeeetttt,
  16.           XXXXttttPPPPooooiiiinnnntttteeeerrrr iiiiggggnnnnoooorrrreeee,
  17.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt ****ccccaaaallllllll____ddddaaaattttaaaa);
  18.  
  19.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  20.           This page documents Motif 2.1.
  21.  
  22.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.           XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt converts a selection to one of a set of
  24.           standard targets.  This function can be called only from an
  25.           XXXXmmmmNNNNccccoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkprocedure or from a ccccoooonnnnvvvveeeerrrrttttPPPPrrrroooocccc trait
  26.           method.
  27.  
  28.           The target to which this routine tries to convert the
  29.           selection is the _t_a_r_g_e_t member of the
  30.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt passed in the _c_a_l_l__d_a_t_a argument.
  31.           If XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt converts the selection to that target,
  32.           it fills in the _v_a_l_u_e, _t_y_p_e, _f_o_r_m_a_t, and _l_e_n_g_t_hmembers of
  33.           the XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt.  Otherwise, it does not alter
  34.           the callback struct.
  35.  
  36.           Note that XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt does not alter the _s_t_a_t_u_smember
  37.           of the XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt. The routine that calls
  38.           XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt is responsible for looking at the _v_a_l_u_e
  39.           parameter and determining whether or not the conversion
  40.           succeeded. If the _v_a_l_u_e parameter contains _N_U_L_L, then the
  41.           conversion did not succeed.
  42.  
  43.           Following are the targets to which XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt
  44.           converts selections:
  45.  
  46.           _B_A_C_K_G_R_O_U_N_D
  47.                     The routine sets the _v_a_l_u_e member of the
  48.                     XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuuccccttttto the value of widget
  49.                     _w_i_d_g_e_t's XXXXmmmmNNNNbbbbaaaacccckkkkggggrrrroooouuuunnnndddd resource.  The routine sets
  50.                     the _f_o_r_m_a_t member to 32, the _l_e_n_g_t_h member to 1,
  51.                     and the _t_y_p_e member to _P_I_X_E_L.
  52.  
  53.           _C_L_A_S_S     The routine finds the first shell in the widget
  54.                     _w_i_d_g_e_t's hierarchy that has a WWWWMMMM____CCCCLLLLAAAASSSSSSSS property.
  55.                     The properties of this shell determine the _v_a_l_u_e,
  56.                     _f_o_r_m_a_t, _l_e_n_g_t_h, and _t_y_p_e members of the
  57.                     XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt.
  58.  
  59.           _C_L_I_E_N_T__W_I_N_D_O_W
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     The routine finds the first shell in the widget
  75.                     _w_i_d_g_e_t's hierarchy.  The routine sets the _v_a_l_u_e
  76.                     member of the XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt to the
  77.                     widget ID of this shell.  This routine sets the
  78.                     _f_o_r_m_a_t member to 32, the _l_e_n_g_t_h member to 1, and
  79.                     the VVVVyyyyppppeeee member to _W_I_N_D_O_W.
  80.  
  81.           _C_O_L_O_R_M_A_P  The routine sets the _v_a_l_u_e member of the
  82.                     XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuuccccttttto the value of widget
  83.                     _w_i_d_g_e_t's XXXXmmmmNNNNccccoooolllloooorrrrmmmmaaaapppp resource (or to the value of
  84.                     the XXXXmmmmNNNNccccoooolllloooorrrrmmmmaaaapppp resource of widget _w_i_d_g_e_t's
  85.                     parent, if _w_i_d_g_e_t is a gadget).  This routine sets
  86.                     the _f_o_r_m_a_t member to 32, the _l_e_n_g_t_h member to 1,
  87.                     and the _t_y_p_e member to _C_O_L_O_R_M_A_P.
  88.  
  89.           _F_O_R_E_G_R_O_U_N_D
  90.                     The routine sets the _v_a_l_u_e member of the
  91.                     XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuuccccttttto the value of widget
  92.                     _w_i_d_g_e_t's XXXXmmmmNNNNffffoooorrrreeeeggggrrrroooouuuunnnndddd resource.  The routine sets
  93.                     the _f_o_r_m_a_t member to 32, the _l_e_n_g_t_h member to 1,
  94.                     and the _t_y_p_e member to _P_I_X_E_L.
  95.  
  96.           _N_A_M_E      The routine finds the first shell in widget
  97.                     _w_i_d_g_e_t's hierarchy that has a WWWWMMMM____NNNNAAAAMMMMEEEE property.
  98.                     The properties of this shell determine the _V_v_a_l_u_e.
  99.                     This routine sets the _f_o_r_m_a_t member to 8, the
  100.                     _l_e_n_g_t_h member to the number of characters in
  101.                     _v_a_l_u_e, and the _t_y_p_e member to the current locale.
  102.  
  103.           _T_A_R_G_E_T_S   The routine sets the _v_a_l_u_e member of the
  104.                     XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuuccccttttto the list of targets
  105.                     returned by XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddTTTTaaaarrrrggggeeeettttssss.  This routine sets
  106.                     the _f_o_r_m_a_t member to 32, the _l_e_n_g_t_h member to the
  107.                     number of targets in the list, and the _t_y_p_e member
  108.                     to _A_T_O_M.
  109.  
  110.           ____MMMMOOOOTTTTIIIIFFFF____RRRREEEENNNNDDDDEEEERRRR____TTTTAAAABBBBLLLLEEEE
  111.                     The routine sets the _v_a_l_u_e member of the
  112.                     XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuuccccttttto the value of the widget
  113.                     _w_i_d_g_e_t's XXXXmmmmNNNNrrrreeeennnnddddeeeerrrrTTTTaaaabbbblllleeeeresource if it exists, or
  114.                     else the default text render table.  More
  115.                     precisely, the _v_a_l_u_e member will hold a string of
  116.                     characters representing the render table.  This
  117.                     routine sets the _f_o_r_m_a_t member to 8, the _l_e_n_g_t_h
  118.                     member to the number of characters in the
  119.                     _v_a_l_u_emember, and the _t_y_p_e member to _S_T_R_I_N_G.
  120.  
  121.           ____MMMMOOOOTTTTIIIIFFFF____EEEENNNNCCCCOOOODDDDIIIINNNNGGGG____RRRREEEEGGGGIIIISSSSTTTTRRRRYYYY
  122.                     The routine transfers the widget's encoding
  123.                     registry.  The routine sets the _v_a_l_u_e member of
  124.                     the XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt to a list of NULL-
  125.                     separated items in the form of tag encoding pairs.
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     This target symbolizes the transfer target for the
  141.                     Motif Segment Encoding Registry.  Widgets and
  142.                     applications can use this Registry to register
  143.                     text encoding formats for specified render table
  144.                     tags.  Applications access this Registry by
  145.                     calling XXXXmmmmRRRReeeeggggiiiisssstttteeeerrrrSSSSeeeeggggmmmmeeeennnnttttEEEEnnnnccccooooddddiiiinnnngggg and
  146.                     XXXXmmmmMMMMaaaappppSSSSeeeeggggmmmmeeeennnnttttEEEEnnnnccccooooddddiiiinnnngggg.  This routine sets the
  147.                     _f_o_r_m_a_t member to 8, the _l_e_n_g_t_h member to the
  148.                     number of characters in the _v_a_l_u_emember, and the
  149.                     _t_y_p_e member to _S_T_R_I_N_G.
  150.  
  151.           Following are the arguments to this function:
  152.  
  153.           _w_i_d_g_e_t    Specifies the reference widget for the conversion.
  154.  
  155.           _i_g_n_o_r_e    This argument is ignored.  Its value should always
  156.                     be _N_U_L_L.
  157.  
  158.           _c_a_l_l__d_a_t_a Specifies a pointer to the XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt
  159.                     to be modified.  XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt modifies the
  160.                     following members of the structure only.  (For
  161.                     details on XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt, see
  162.                     XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee(3) in the _M_o_t_i_f _P_r_o_g_r_a_m_m_e_r'_s
  163.                     _R_e_f_e_r_e_n_c_e.)
  164.  
  165.                     _v_a_l_u_e     An _X_t_P_o_i_n_t_e_r parameter that contains any
  166.                               data that XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt produces as
  167.                               a result of the conversion.
  168.                               XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt sets _v_a_l_u_eto _N_U_L_L if
  169.                               it cannot convert the target.
  170.  
  171.                     _t_y_p_e      An AAAAttttoooommmm parameter that indicates the
  172.                               type of the data in the _v_a_l_u_e member.
  173.  
  174.                     _f_o_r_m_a_t    An _i_n_t parameter that specifies whether
  175.                               the data in _v_a_l_u_eshould be viewed as a
  176.                               list of 8-bit, 16-bit, or 32-bit
  177.                               quantities.
  178.  
  179.                     _l_e_n_g_t_h    An uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg parameter that
  180.                               specifies the number of elements of data
  181.                               in _v_a_l_u_e, where each element has the
  182.                               number of bits specified by _f_o_r_m_a_t.
  183.  
  184.      RRRREEEELLLLAAAATTTTEEEEDDDD
  185.           XXXXmmmmQQQQTTTTttttrrrraaaannnnssssffffeeeerrrr(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee(3),
  186.           XXXXmmmmeeeeCCCClllliiiippppbbbbooooaaaarrrrddddSSSSiiiinnnnkkkk(3), XXXXmmmmeeeeCCCClllliiiippppbbbbooooaaaarrrrddddSSSSoooouuuurrrrcccceeee(3),
  187.           XXXXmmmmeeeeCCCCoooonnnnvvvveeeerrrrttttMMMMeeeerrrrggggeeee(3), XXXXmmmmeeeeDDDDrrrraaaaggggSSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeDDDDrrrrooooppppSSSSiiiinnnnkkkk(3),
  188.           XXXXmmmmeeeeGGGGeeeettttEEEEnnnnccccooooddddiiiinnnnggggAAAAttttoooommmm(3), XXXXmmmmeeeePPPPrrrriiiimmmmaaaarrrryyyySSSSiiiinnnnkkkk(3),
  189.           XXXXmmmmeeeePPPPrrrriiiimmmmaaaarrrryyyySSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSiiiinnnnkkkk(3),
  190.           XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr(3),
  191.           XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddTTTTaaaarrrrggggeeeettttssss(3), and XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc(3).
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 4/6/01)
  196.  
  197.  
  198.  
  199.